Vcenter Ovf DeploymentOption

Vcenter Ovf DeploymentOption
Vcenter Ovf DeploymentOption

The Vcenter Ovf DeploymentOption schema contains the information about a deployment option as defined in the OVF specification.

This corresponds to the ovf:Configuration element of the ovf:DeploymentOptionSection in the specification. The ovf:DeploymentOptionSection specifies a discrete set of intended resource allocation configurations. This schema represents one item from that set.

See POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=deploy and POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=filter.

JSON Example
{
    "key": "string",
    "label": "string",
    "description": "string",
    "default_choice": false
}
string
key
Optional

The key of the deployment option, corresponding to the ovf:id attribute in the OVF descriptor.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

string
label
Optional

A localizable label for the deployment option.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

string
description
Optional

A localizable description for the deployment option.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

boolean
default_choice
Optional

A boolean flag indicates whether this deployment option is the default choice.

This property is not used in the input parameters when deploying an OVF package. This property is optional in the result when retrieving information about an OVF package. If missing or null or false, it is not the default.

Property Of